home *** CD-ROM | disk | FTP | other *** search
/ Aminet 25 / Aminet 25 (1998)(GTI - Schatztruhe)[!][Jun 1998].iso / Aminet / dev / c / CLib37x.readme < prev    next >
Text File  |  1998-05-05  |  18KB  |  366 lines
  1. Short:    Example.library in 100% C (SAS/Storm/Maxon/GCC/VBCC/DICE/...)
  2. Author:   (various, see below)
  3. Uploader: Andreas_Kleinert@t-online.de
  4. Type:     dev/c
  5.  
  6.   example.library V37.31 (18.3.98)
  7.  
  8.   An Amiga shared library in 100 % C language - coming with sources.
  9.  
  10.   Compiler Checklist:        Compiler           Support
  11.                              -------------------------------
  12.    (see README.<compiler>    SAS/C 6.5x         yes
  13.     for more information)    MaxonC 3.x         yes
  14.                              StormC 2.x         yes
  15.                              DICE 3.x           yes
  16.                              GCC 2.7.2.1        yes
  17.                              vbcc 0.5+          yes
  18.                              AztecC             (not tested)
  19.  
  20.   OS Checklist:              Operating System   Support
  21.                              -------------------------------
  22.                              Amiga OS 37-40     yes
  23.                              AROS 1.x           yes (AROS source tree)
  24.  
  25.  
  26.   Original SAS/C and StormC version (C) 1996-98 by Andreas R. Kleinert,
  27.   MaxonC version changes done 1996 by Helmut Hummel and Stephan Rupprecht.
  28.   GCC version changes done 1997 by Stefan Fuchs and Gunter Nikl.
  29.   AROS source tree done 1997 by Aaron Digulla.
  30.   VBCC version changes done 1997 by Patrizio Biancalani and Patrick Burnand.
  31.   DICE adaptation done 1998 by Patrick Burnand.
  32.   All rights reserved.
  33.   ----------------------------------------------------------------------
  34.   This sample library intends to make Amiga shared library sources
  35.   compileable with any available Amiga C compiler - without any
  36.   changes to the source code.
  37.   And maybe in the future also running under any Amiga compatible
  38.   operating system with any CPU.
  39.  
  40.   The first goal seams to be easily done: nearly any noticeable compiler
  41.   for the Amiga does support generation of libraries by special
  42.   linker commands and pre-generated object files.
  43.  
  44.   But when looking into the details, one will find out, that these
  45.   linker functionality just reduces the influence of the programmer
  46.   on how his sources are handled, that the pre-generated object
  47.   files just originally were done in Assembler, and that each compiler
  48.   does define its own interface definitions and usage rules.
  49.  
  50.   But as a programmer, it is important to have control over the _complete_
  51.   source code and to be able to compile it _anywhere_ with only
  52.   minor changes, even better without any changes.
  53.  
  54.   Since most Amiga system modules - noticeable Libraries, Devices and
  55.   Resources - do have startup-modules and other larger parts completely
  56.   written in Assembler language, the most important task for getting
  57.   inter-compiler and operating system independant sources in my opinion
  58.   is, to completely migrate the interfaces to C language (but different
  59.   to AROS, for example, it is most important, to keep the sources running
  60.   under the current 68k AmigaOS in the _first_ place).
  61.  
  62.   This goal basically has been reached already, still missing of
  63.   course are some of the less Amiga-native compilers and of course
  64.   tests with any kind of "AmigaOS for PowerPC".
  65.  
  66.   But since Assembler is nearly as portability-hostile as BCPL _today_
  67.   we may come quite close to the goal defined above by just moving
  68.   towards C.
  69.  
  70.   Translate your 68k-assembler library startup-codes smartly
  71.   to C by simply using this source-code as an advice how to do it.
  72.  
  73.   For testing: install the (re)compiled example.library to LIBS: and
  74.   start the test program - it should pop up a requester, then.
  75.  
  76.   If you can submit adjustments for the other compilers as mentioned
  77.   above: feel free to send these.
  78.   ---
  79.   Feel free to use this source for own projects.
  80.  
  81.   It is allowed to be spread and distributed anywhere, as far
  82.   as my consent is concerned.
  83.  
  84.   Amiga International, or the current owner of the technologie,
  85.   is allowed to always put this source on their newest
  86.   Developer CD-ROM.
  87.  
  88.   Thanks and credits will always be appreciated - for example,
  89.   you MAY, but NEED NOT:
  90.   give me credits in your program's docs, send me keyfiles for
  91.   your programs using the library, and so on.
  92.   But that's simply voluntarily.
  93.  
  94.    _________________________________________________________
  95.   |      You may reach me the following way.                |
  96.   |    Send bug-reports, money or whatever to:              |
  97.   |---------------------------------------------------------|
  98.   |        * SuperView Development & Registration *         |
  99.   |          * DRAFU Development & Registration *           |
  100.   |       * Image Engineer Registration Site Europe *       |
  101.   |                                                         |
  102.   |                                                         |
  103.   |                  PerSuaSiVe SoftWorX                    |
  104.   |                                                         |
  105.   |                  Andreas R. Kleinert                    |
  106.   |                  Sandstrasse 1                          |
  107.   |                  D-57072 Siegen                         |
  108.   |                  Germany, Europe                        |
  109.   |                                                         |
  110.   | Any snail mail to the old address will still be routed. |
  111.   |                                                         |
  112.   |                  Phone:  +49-271-22869 also FAX + AM    |
  113.   |                          +49-271-22838                  |
  114.   |                                                         |
  115.   |                  Weekdays after 17.00h.                 |
  116.   |                                                         |
  117.   |         When calling via phone you may leave a message, |
  118.   |         if I'm not available - but don't expect me      |
  119.   |         calling back to USA, Australia, ... since       |
  120.   |         german phone rates are HIGHLY expensive.        |
  121.   |_________________________________________________________|
  122.  
  123.     http://home.t-online.de/home/Andreas_Kleinert/
  124.  
  125.   eMail:
  126.  
  127.         Please send binaries via ARK@News.wwbnet.de, and keep
  128.         them smaller than 16 KB. Please think twice before
  129.         sending them - my postbox is not unlimited in size.
  130.  
  131.            - Fido    Andreas Kleinert 2:2457/350.18
  132.            - Usenet
  133.                      Andreas_Kleinert@superview.ftn.neckar-alb.de (Fido-Gate)
  134.                      Andreas_Kleinert@t-online.de                 (T-Online)
  135.                      ARK@News.wwbnet.de                           (Z-Netz)
  136.                      ARK@amigaworld.com                           (AmigaWorld)
  137.  
  138.            - If nothing else works, try one of these public
  139.              Fido-Usenet gateways:
  140.  
  141.                In Germany:
  142.                  Andreas_Kleinert@p18.f350.n2457.z2.fido.sub.org
  143.  
  144.                From USA or elsewhere:
  145.                  Andreas_Kleinert@p18.f350.n2457.z2.fidonet.org
  146.  
  147.  
  148.  Known Bugs:        - some versions of DOpus and all Installer versions
  149.                       can't fetch the version information from the
  150.                       library binary due to some bugs in their code.
  151.                       Newer DOpus versions have this fixed and C:Version
  152.                       for example did that task always.
  153.  
  154.  
  155.  History:
  156.  
  157.  V37.31 (18.03.98): - changed SEGLISTPTR type definition for VBCC
  158.                       (-> Patrick Burnand)
  159.                     - fixed some typos and improved style in several
  160.                       source modules and headers
  161.  
  162.  V37.30 (07.03.98): - added DICE support, done by Patrick Burnand
  163.                       <pburnand@hotmail.com>
  164.                       He modified LibInit.c and StartUp.c to avoid a possible
  165.                       bug in DICE.  The 'extern' keyword might not always be
  166.                       supported well.  (extern struct ExampleBase*...)
  167.                     - added some typecasts to InitTable definition
  168.                       (so that the other compilers can't complain about the
  169.                        changes done for DICE)
  170.                     - simplified sample program
  171.                     - again fixed type definition of "seglist" pointer;
  172.                       it's now a global typedef-inition/#define in compiler.h
  173.                       (SEGLISTPTR) so everyone should be happy again
  174.                       (-> Sven Drieling)
  175.  
  176.  V37.22 (29.12.97): - fixed TestExampleLib.c
  177.                       (-> Stephan Rupprecht)
  178.                     - updated Stephan's email address
  179.                       (now is: stephan.rupprecht@metronet.de)
  180.                     - renamed "c_lib" directory and "ReadMe_First"
  181.                       to CLib37x#?
  182.  
  183.  V37.21 (19.12.97): - adjusted "compiler.h" as suggested by Volker Barthelmann
  184.                       (VBCC), done by Patrizio Biancalani
  185.                     - updated Patrizio's email address (-> ReadMe.VBCC)
  186.                     - fixed my email, too (how did that COB.wwbnet.de make
  187.                       it into this readme again ?)
  188.                     - "compiler.h" now protected from multiple #inclusion
  189.  
  190.  V37.20 (02.12.97): - added VBCC support, done by Patrizio Biancalani
  191.                       <P.Biancalani@agora.stm.it>
  192.  
  193.  V37.17 (24.10.97): - updated "ReadMe_MAXON" and added a bug-description
  194.                       (plus workaround) as supplied by Stephan Rupprecht
  195.                       <Rupprecht_Verwertung@t-online.de>
  196.                       [ 29/12/97: stephan.rupprecht@metronet.de ]
  197.  
  198.  V37.16 (23.8.97) : - V37.15 - frozen AROS spin-off
  199.                     - AROS-Version now included with AROS package, separately
  200.                     - added comments about Forbid/Permit/Wait/single-threading
  201.                       to the Library access functions
  202.                     - also commented the rest a little bit
  203.                       (-> maybe some certain people from comp.sys.amiga.programmer
  204.                           now feel better - but then again... maybe not ;)
  205.  
  206.  V37.14 (13.8.97) : - AROS: - the LH1_ to LH2_ macro replacements in
  207.                               "compiler.h" had been wrongly defined
  208.                             - "BPTR" type only was available under AROS,
  209.                               now using "struct SegList *"
  210.                             - AROS version now does compile under AmigaOS
  211.                               with SAS/C 6.58, too
  212.                     - "APTR seglist" now "struct SegList *"
  213.  
  214.  V37.13 (19.7.97) : - GNU makefile had lost its TABs
  215.                       (-> Gunter Nikl)
  216.  
  217.  V37.12 (29.6.97) : - fixed memory bug-fix (argh)
  218.                       (-> Gunter Nikl)
  219.                     - changed/applied GCC adjustments
  220.                       (-> diffs by Gunter Nikl)
  221.  
  222.  V37.11 (24.6.97) : - added "known bugs" section
  223.                     - LibInit now delocates library base on error
  224.                       (NULL return)
  225.                       (-> Gunter Nikl)
  226.                     - added AROS version, and created an additional
  227.                       source tree for it, since I did not get it compiled
  228.                       with SAS/C 6.57 and there's perhaps additional
  229.                       #ifdef stuf to be done. Anyone likes to merge these ?
  230.                       (-> Aaron Digulla)
  231.  
  232.  V37.10 (6.4.97) :  - added GCC version by Stefan Fuchs, snfuchs@sokrates.franken.de.
  233.                       Thanks !
  234.                     - some small changes to docs, includes and comments
  235.                     - still missing: DICE, Aztec, vbcc. Who does it ?
  236.                     - fixed ftn email address
  237.  
  238.  V37.6 (27.3.97) :  - finetuning
  239.  
  240.  V37.5 (24.1.97) :  - rewrote docs
  241.                     - added basic support for compiler independent
  242.                       register naming and SAS/C keyword replacements
  243.                       (compiler.h). Thus sources now should be easily
  244.                       adaptable for GCC as well.
  245.  
  246.  V37.4 (8.1.97) :   - added FD file
  247.                     - added new pragma file (and dir) as
  248.                       include/pragma/example_lib.h
  249.                       which works with Aztec, Maxon, Storm,
  250.                       DICE and SAS C compilers.
  251.                       Thanks to fd2pragma and Dirk Stoecker.
  252.                     - some fixes to the readme files
  253.                     - updated eMail list
  254.  
  255.  V37.3 (3.1.97) :   - slightly changed SCOPTIONS
  256.                     - fixed some style things (APTR and library casts)
  257.                     - changed note about library opening at L_OpenLibs()
  258.                     - now compileable with StormC 2.0 as well
  259.                       (not tested with 1.1) - see readme file for StormC
  260.                     - added project file for StormC 2.0, smakefile still
  261.                       present - select, which one you'd like to use
  262.  
  263.  V37.2 (12.12.96) : - applied some more changes and fixes
  264.                       (-> suggested by Helmut Hummel)
  265.                     - added icons
  266.                       (-> from Helmut Hummel)
  267.  
  268.  V37.1 (4.12.96) : - bumped version to V37
  269.                    - added MaxonC 3.x version by applying changes
  270.                      to the SAS/C sources and adding Maxon
  271.                      specific make and configuration files
  272.                      (-> all done by Helmut Hummel, see Readme.MAXON)
  273.                    - added StormC support
  274.                    - yet missing: DICE, Aztec, GNU. Who does it ?
  275.  
  276.  V1.4 (30.11.96) : - added SAS/C specific Ctrl-C disabling code
  277.                    - made some workarounds compiler sensitive
  278.                    - redone all with SAS/C V6.57
  279.                    - 944 Bytes ;-)
  280.  
  281.  V1.3 (13.9.96) :  - when starting lib as executable, -1 must be returned
  282.                    - now caching SysBase
  283.                    - added some comments, where changes should not
  284.                      be applied
  285.                    - added note about sharing library bases
  286.                    - documented and modified sample function,
  287.                      so that correct a0/a1/d0/d1 and a6 usage becomes
  288.                      more obviously and verbose
  289.                    - still 940 bytes ;-)
  290.  
  291.  V1.2 (5.9.96)  :  - fixed some things resulting out of a
  292.                      discussion in Z-Netz
  293.  
  294.  V1.1 (1.9.96)  :  - small changes in style
  295.                      (only bumped versions of changed modules):
  296.                        o moved "examplebase.h" to include/example/
  297.                          (so also adjusted LibInit.c, StartUp.c
  298.                           and SCOPTIONS for reflecting that)
  299.                        o SampleFuncs.h did contain wrong prototype
  300.                          (did not matter, since only used for
  301.                           ULONG function table within StartUp.c)
  302.                        o explicitely __aligned ROMTag structure
  303.  
  304.  V1.0 (14.8.96) : - first release
  305.  
  306.  
  307.  ---
  308.  All mentioned trademarks are subject to their owners.
  309.  
  310.  
  311. ============================= Archive contents =============================
  312.  
  313. Original  Packed Ratio    Date     Time    Name
  314. -------- ------- ----- --------- --------  -------------
  315.     1720     433 74.8% 11-Dec-96 15:39:54 +bin.info
  316.     5252    3484 33.6% 07-Mar-98 13:52:12 +TestExampleLib
  317.      450     230 48.8% 11-Dec-96 15:49:34 +TestExampleLib.info
  318.     2101    1066 49.2% 23-Aug-97 11:40:22 +ReadMe.AROS
  319.     1209     658 45.5% 07-Mar-98 13:28:48 +ReadMe.DICE
  320.     1884     861 54.2% 01-Apr-97 11:27:18 +ReadMe.GCC
  321.     1844     985 46.5% 29-Dec-97 20:02:56 +ReadMe.MAXON
  322.      503     288 42.7% 29-Dec-97 20:03:44 +ReadMe.SAS
  323.      936     496 47.0% 29-Dec-97 20:04:02 +ReadMe.STORM
  324.      778     424 45.5% 19-Dec-97 09:13:50 +ReadMe.VBCC
  325.     1720     433 74.8% 11-Dec-96 15:39:56 +source.info
  326.      125     117  6.4% 08-Jan-97 19:09:50 +example.fd
  327.      425     247 41.8% 05-Dec-96 11:45:24 +example_protos.h
  328.      289     185 35.9% 05-Dec-96 11:44:58 +example.h
  329.      657     323 50.8% 07-Mar-98 13:50:38 +examplebase.h
  330.      477     247 48.2% 08-Jan-97 19:10:26 +example_lib.h
  331.      311     207 33.4% 05-Dec-96 11:45:38 +example_pragmas.h
  332.      330     207 37.2% 05-Dec-96 11:45:50 +example.h
  333.     1720     433 74.8% 11-Dec-96 15:39:42 +lib_source.info
  334.       25      25  0.0% 05-Dec-96 12:07:46 +make_storm.bat
  335.      360     186 48.3% 07-Mar-98 13:28:48 +makefile.dice
  336.      427     223 47.7% 19-Jul-97 14:07:00 +makefile.gcc
  337.      419     164 60.8% 11-Dec-96 15:31:14 +makefile.MAXON
  338.      347     232 33.1% 05-Dec-96 11:36:28 +makefile.MAXON.info
  339.      347     181 47.8% 02-Dec-97 10:34:46 +makefile.vbcc
  340.      381     232 39.1% 05-Dec-96 11:36:28 +mcpp.SESSION
  341.     1591     824 48.2% 02-Dec-97 10:34:46 +SampleFuncs.c
  342.      370     248 32.9% 02-Dec-97 10:34:46 +SampleFuncs.h
  343.      128     105 17.9% 03-Jan-97 15:29:36 +SCOPTIONS
  344.      395     148 62.5% 05-Dec-96 11:36:28 +smakefile
  345.       95      85 10.5% 05-Dec-96 11:36:28 +smakefile.wth
  346.     1757     595 66.1% 03-Jan-97 15:44:56 +storm_project.¶
  347.      624     350 43.9% 03-Jan-97 15:44:56 +storm_project.¶.info
  348.      622     269 56.7% 03-Jan-97 15:44:30 +storm_smakefile
  349.      119     100 15.9% 05-Dec-96 11:36:28 +SCOPTIONS
  350.      256     105 58.9% 05-Dec-96 11:36:28 +smakefile
  351.     5252    3484 33.6% 07-Mar-98 13:52:12 +TestExampleLib
  352.      762     410 46.1% 07-Mar-98 13:36:24 +TestExampleLib.c
  353.      835     394 52.8% 05-Dec-96 11:36:28 +TestExampleLib.info
  354.      380     278 26.8% 07-Mar-98 13:52:10 +TestExampleLib.o
  355.    14632    5170 64.6% 18-Mar-98 09:48:24 +CLib37x.readme
  356.      888     600 32.4% 18-Mar-98 09:47:42 +example.library
  357.     5361    1664 68.9% 18-Mar-98 09:36:12 +compiler.h
  358.      888     600 32.4% 18-Mar-98 09:47:42 +example.library
  359.     5413    1901 64.8% 18-Mar-98 09:43:22 +LibInit.c
  360.      868     534 38.4% 18-Mar-98 09:47:38 +LibInit.o
  361.      216     194 10.1% 18-Mar-98 09:47:42 +SampleFuncs.o
  362.    10208    2527 75.2% 18-Mar-98 09:47:22 +StartUp.c
  363.      828     513 38.0% 18-Mar-98 09:47:34 +StartUp.o
  364. -------- ------- ----- --------- --------
  365.    77525   33665 56.5% 19-Mar-98 00:03:32   49 files
  366.